/* Copyright 2009
 *
 * This program and the accompanying materials
 * are made available under the terms of the
 * Eclipse Public License v1.0 which accompanies
 * this distribution, and is available at
 *
 * 		http://www.eclipse.org/legal/epl-v10.html
 *
 * Unless required by applicable law or agreed to in
 * writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 * OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * Contributors:
 * 	   IBM Corporation - initial API and implementation for JDT/DLTK
 *     Sean W. Quinn - initial adoption for use with PHP from various sources.
 */
package org.eclipse.php.core.util;

/**
 * <p>
 * This class represents a generic script file attribute, for the PHP
 * Development Toolkit (PDT). It is intended to be extended for any new
 * attribute.
 * </p>
 * <p>
 * The genesis of this interface is from the JDT class
 * {@link org.eclipse.jdt.core.util.IClassFileAttribute}.
 * </p>
 *
 * @author Sean W. Quinn (swquinn@gmail.com)
 * @see org.eclipse.jdt.core.util.IClassFileAttribute
 */
public interface IScriptFileAttribute {

	/**
	 * Answer back the attribute name index in the constant pool as specified in
	 * the JVM specifications.
	 *
	 * @return the attribute name index in the constant pool
	 */
	int getAttributeNameIndex();

	/**
	 * Answer back the attribute name as specified in the JVM specifications.
	 *
	 * @return the attribute name
	 */
	char[] getAttributeName();

	/**
	 * Answer back the attribute length as specified in the JVM specifications.
	 *
	 * @return the attribute length
	 */
	long getAttributeLength();
}
